Skip to content

docs: fix note#12982

Merged
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-t-2026-06-20
Jun 20, 2026
Merged

docs: fix note#12982
kgryte merged 1 commit into
developfrom
philipp/drift-stats-base-dists-t-2026-06-20

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Fix a documentation inconsistency in @stdlib/stats/base/dists/t/entropy.

stats/base/dists/t/entropy

docs/repl.txt stated the function returns NaN for v < 0, but the
implementation in lib/main.js (if ( isnan( v ) || v <= 0.0 )) returns
NaN for any v <= 0. The README and TypeScript declaration already
use v <= 0; this aligns the REPL help with code and sibling docs
(13/14 packages in the namespace pair REPL boundary wording with the
lib/main.js check verbatim — 93% conformance).

Related Issues

None.

Questions

None.

Other

None.

Checklist

AI Assistance

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

Authored by Claude Code via a within-namespace API drift detection routine. A
random namespace was selected, structural and semantic features were extracted
from every package, and a three-agent validation pass (semantic-review,
cross-reference, structural-review) confirmed the single drift candidate
before the fix was applied. No tests or observable behavior were modified.


@stdlib-js/reviewers


Generated by Claude Code

…PL help

The REPL help text stated `v < 0` returns `NaN`, but the implementation
returns `NaN` for any `v <= 0` (see `lib/main.js`). The README and
TypeScript declarations already use `v <= 0`; update the REPL text to
match (13/14 sibling packages in the namespace already pair REPL boundary
wording with the `lib/main.js` check verbatim).
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jun 20, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/t/entropy $\\color{green}171/171$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}171/171$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte kgryte marked this pull request as ready for review June 20, 2026 22:50
@kgryte kgryte requested a review from a team June 20, 2026 22:50
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 20, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jun 20, 2026
@kgryte kgryte changed the title docs: fix v boundary in stats/base/dists/t/entropy REPL help docs: fix note Jun 20, 2026
@kgryte kgryte merged commit 1f05813 into develop Jun 20, 2026
70 checks passed
@kgryte kgryte deleted the philipp/drift-stats-base-dists-t-2026-06-20 branch June 20, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants